home *** CD-ROM | disk | FTP | other *** search
/ Programming Languages Suite / ProgLangD.iso / BORLAND TURBO ASSEMBLER / FILT.PAK / README < prev   
Text File  |  1996-01-10  |  7KB  |  183 lines
  1.  
  2.                        FILT VERSION 1.0
  3.                        ----------------
  4.      Copyright (c) 1988, 1993 by Borland International, Inc.
  5.  
  6.  
  7. TABLE OF CONTENTS
  8. -----------------
  9. 1. What is FILT?
  10. 2. Summary of Options
  11. 3. Descriptions of Options
  12.  
  13.  
  14. 1. WHAT IS FILT?
  15. ----------------
  16.  
  17.   FILT is a text-filter program that performs some low-level formatting and 
  18.   translation functions. As a filter, FILT does its input and output through 
  19.   the console device (CON). Input and output files must be specified with the
  20.   DOS redirection commands. Here's the basic syntax:
  21.  
  22.     FILT options < input_file > output_file
  23.  
  24.   The options consist of single letters and are described below. The 
  25.   input_file and output_file, in conjunction with the redirection characters, 
  26.   < and >, tell DOS what files to use for input and output. If no input file 
  27.   is specified, the keyboard will be used. If no output file is specified, the 
  28.   screen will be used.
  29.  
  30.   The options are single, case-sensitive letters. Any number of options may be 
  31.   specified, and some of the options are followed by a number. All numbers are 
  32.   decimal and come immediately after the option letter (with no intervening
  33.   spaces); numbers over 65,535 will cause an error.
  34.  
  35.  
  36. 2. SUMMARY OF OPTIONS
  37. ---------------------
  38.  
  39.   Note: # denotes number
  40.  
  41.   Tab Replacement                 
  42.   ---------------                 
  43.   x  = expands tabs to spaces     
  44.   c  = compresses spaces to tabs  
  45.  
  46.   Tab Assignment
  47.   --------------
  48.   e  = erases all tab stops
  49.   t# = sets tab stop
  50.  
  51.   Character Replacement        
  52.   ---------------------
  53.   S  = strips high bits            
  54.   C  = strips control chars        
  55.   H  = strips high (>127) bytes    
  56.   U  = all letters to uppercase    
  57.   L  = all letters to lowercase    
  58.   A  = capitalize words            
  59.  
  60.   Line Format
  61.   -----------
  62.   m  = adds left margin
  63.   d  = deletes left margin    
  64.   l# = truncates long lines
  65.   r  = removes trailing spaces 
  66.   b# = byte to end input lines 
  67.   s  = saves carriage returns 
  68.  
  69.   End of File
  70.   -----------
  71.   z  = ignores ^Z in input
  72.   Z  = suppresses ^Z in output
  73.  
  74.   I/O Buffer
  75.   ----------
  76.   i#  = input buffer size (20000)
  77.   o#  = output buffer size (20000)
  78.  
  79.  
  80. 3. DESCRIPTIONS OF OPTIONS
  81. --------------------------
  82.  
  83.   The following fully describes all options in alphabetical  order (lowercase 
  84.   first):
  85.  
  86.   ?   Help.  Displays a summary of the options.
  87.  
  88.   b#  Byte to end input lines. Defines the character that will identify an end
  89.       of line (EOL). For instance, b13 will cause a line to be ended when a 
  90.       carriage return is reached. The default is b10. This option does not 
  91.       effect how EOL's will be written; they are always ended with a CR+LF 
  92.       combination.
  93.  
  94.   c   Compresses spaces to tabs. When possible, spaces will be replaced by tab
  95.       characters (ASCII 9). The default tab stops are every eight columns, but 
  96.       can be set manually with the e and t options.
  97.  
  98.   d#  Deletes left margin. The specified number of characters will be deleted 
  99.       from the left side of all the lines. Any characters will be deleted.  
  100.       Note that tabs only count as one character.
  101.  
  102.   e   Erases all tab stops. All tab stops will be erased. User-defined tab 
  103.       stops (set with the t option) should come after the e option.
  104.  
  105.   h   Help. Displays a summary of the options.
  106.  
  107.   i#  Input buffer size. Sets the size of the input buffer. The default is 
  108.       i20000. Making it larger might improve the processing rate for a slow 
  109.       input device, while making it smaller will use less memory.
  110.  
  111.   l#  Truncate long lines. Lines longer than the specified length will be 
  112.       truncated. Normally any length lines (up to about  600 characters) are 
  113.       acceptable.
  114.  
  115.   m#  Add left margin. The specified number of spaces will be added to the 
  116.       left margin.
  117.  
  118.   o#  Output buffer size. Set the size of the output buffer.  The default is 
  119.       o20000. Making it larger might improve the processing rate for a slow 
  120.       output device, while making it smaller will use less memory.
  121.  
  122.   s   Saves carriage returns. All carriage returns (ASCII 13) are normally 
  123.       deleted from the input. This option might be useful in a file that 
  124.       contains line boundaries without carriage returns, but does contain 
  125.       carriage returns as some kind of special formatting code.
  126.  
  127.   r   Removes trailing spaces. Any spaces (or tabs when using the c option) 
  128.       that come at the end of lines will be removed. Spaces at the end of 
  129.       lines, though superfluous, are often left over from word processors.
  130.  
  131.   t#  Sets a tab stop. A tab stop will be set at the specified column number.  
  132.       The leftmost column is column one. Any number of tab stops can be 
  133.       specified. The default tab stops are every eight columns, i.e., t9 
  134.       t17 t25 etc.
  135.  
  136.   x   Expands tabs to spaces. All tab characters (ASCII 9) will be replaced 
  137.       with an equivalent number of spaces. The default tab stops are every 
  138.       eight columns, but can be set manually with the e and t options.
  139.  
  140.   z   Ignores ^Z in the input file. A ^Z (ASCII 26) normally identifies the 
  141.       end of a file. If this option is used, the full number of bytes recorded
  142.       in the directory will be read.
  143.  
  144.   A   Capitalize words. Letters that follow another letter will be converted 
  145.       to lowercase, all other letters will be converted to uppercase.
  146.  
  147.   C   Strips control characters. All characters below ASCII 32 will be 
  148.       removed. The exceptions are the CR, LF, and Ctrl-Z characters.
  149.  
  150.   H   Strips high bytes. All characters above ASCII 127 will be removed.
  151.  
  152.   L   Converts all letters to lowercase.
  153.  
  154.   S   Strips high bits. The high bit of all bytes above ASCII 127 will be 
  155.       cleared.
  156.  
  157.   U   Converts all letters to uppercase.
  158.  
  159.   Z   Suppresses ^Z in the output file. Normally a ^Z (ASCII 26) is written to 
  160.       the end of the file. If this option is used, a ^Z will not be written.
  161.  
  162.   The following are some examples of FILT option and file specifications:
  163.  
  164.   filt ?
  165.     Displays a summary of all options to the screen.
  166.  
  167.   filt cr < data.fil > data.new
  168.     Means: c = compress spaces to tab characters; r = remove trailing spaces.  
  169.     The input file is DATA.FIL and the output file is DATA.NEW. This 
  170.     combination of options may greatly reduce the size of a file by compressing 
  171.     or removing unnecessary spaces.
  172.  
  173.   filt zZCHi500o500 < a:text.xxx > c:\doc\text.txt
  174.     Means: z = ignore any input ^Zs; Z = do not write a ^Z to the end of the 
  175.     file; C = remove all control characters; H = remove any characters with a 
  176.     value greater than 127; i500 = set the input buffer size to 500 bytes; 
  177.     o500 = set the output buffer size to 500 bytes. The input file is 
  178.     A:TEXT.XXX and the output file is C:\DOC\TEXT.TXT. This combination of
  179.     options converts the input file into a pure ASCII file with no control 
  180.     characters (except for the line boundaries). Note that about 39,000 fewer 
  181.     bytes of memory are used during execution because of the buffer sizes, 
  182.     500+500=1000 instead of the default 20000+20000=40000.
  183.